<?php
/**
 * Slipstream :: Highly adaptive dependency injection framework
 * Copyright 2010-2011 Ian Unruh (Xerof3ar)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace Slipstream\Extension;
use Slipstream\ContainerInterface;
use Slipstream\Activation\SessionInterface;

/**
 *
 *
 * @author Ian Unruh (Xerof3ar) <ianunruh@gmail.com>
 * @since Class avaliable since release 1.0
 */
interface RegistryInterface
{
	/**
	 * Registers an extension with this container
	 *
	 * @param ExtensionInterface $extension
	 * @return void
	 */
	public function register(ExtensionInterface $extension);
	
	/**
	 * Unregisters an extension from this container
	 *
	 * @param ExtensionInterface $extension
	 * @return void
	 */
	public function unregister(ExtensionInterface $extension);
	
	/**
	 * Returns true if an extension is registered with the container
	 *
	 * @param ExtensionInterface $extension
	 * @return bool
	 */
	public function isRegistered(ExtensionInterface $extension);
	
	/**
	 * Returns the extensions registered with this container
	 * @return SplObjectStorage<ExtensionInterface>
	 */
	public function getExtensions();
	
	/**
	 * Returns the container that this registry belongs to
	 * @return ContainerInterface
	 */
	public function getContainer();
	
	/**
	 * Called when an activation session begins
	 *
	 * @param SessionInterface $session
	 * @return void
	 */
	public function onSessionStart(SessionInterface $session);
	
	/**
	 * Called when an activation session finishes
	 *
	 * @param SessionInterface $session
	 * @return void
	 */
	public function onSessionFinish(SessionInterface $session);
}